CONTENT MANAGEMENT

The Content Management component is responsible for managing the title and title list entities. This document describes the Content Management resource type and the available node definitions that may be used in a workflow template when using with the Content Management resource type.

PROPERTIES
Resource Type Name Content Management
Resource Type System ID CM
SUPPORTED NODE DEFINITIONS
Message UID Node Definition Name
01CM01 * Generate Metadata
01CM02 * Get Original File Info
01CM03 * Get Metadata Field Value
01CM04 * Nationalize Title
01CM05 Delete Title
01CM06 * Get All Files
01CM07 * Get File Info
01CM10 * Validate Metadata by spec
01CM11 * Validate Title by spec
01CM12 Send Ingested Event to RuleEngine
01CM13 * Localize Title
01CM14 * Unregister All Files
01CM16 Get Title
01CM18 Nationalize
01CM19 Localize
01CM21 Validate Title
01CM22 Retire Title
01CM23 Get Title Metadata
01CM24 Get Title Status
01CM25 Get Title Property
01CM26 Set Title Property
01CM27 Get Title Properties
01CM28 Get Asset Id by AssetType
01CM29 Get Asset Id List by AssetType
01CM30 Get Asset Ids
01CM31 Get Asset Details
01CM32 Get Asset Metadata Value
01CM33 Get asset Metadata Values
01CM34 Set Asset Metadata Value
01CM35 Set Asset Metadata Values List
01CM36 Get Mapping for Metadata
01CM37 Create Title for Package
01CM38 Update Title For Package
01CM40 Create Title For Metadata
01CM41 Update Title for Metadata
01CM43 Get Mapping For Content
01CM44 Update Title For Content
01CM47 Register Key Frames
01CM49 Register Still Image
01CM51 Generate URL for Fix Title Validation
01CM52 Generate URL for Title Asset Mapping
01CM53 Generate URL for Title Mapping Completion
01CM54 Add Title Progress
01CM56 Get Asset Metadata Custom Field Value
01CM57 Get Asset Metadata Custom Field Values
01CM58 Set Asset Metadata Custom Field Value
01CM59 Set Asset Metadata Custom Field Values
01CM60 Get Asset File Id
01CM61 Get Unmapped Content Path
01CM62 Get Content Assets For Title
01CM63 Get Metadata Path for Package
01CM64 Update Title Asset For Content
01CM65 Search Title
01CM66 * Merge Title
01CM70 Export Title List
01CM71 Get Unmapped Content Path For Title Asset
01CM72 Get Asset Id List From Title List
01CM73 Get Title Id List From Title List
01CM74 Get File Properties by Lookup Key
01CM75 Set File Properties
01CM76 Register Derived File
01CM77 Unregister All Asset Files
01CM78 Get Original File Properties
01CM79 Execute Saved Search
01CM80 Get File Properties
01CM81 Get All Title List IDs
01CM82 Get Title List Properties
01CM83 Get Title Count by Provider Id and Date
01CM84 Get Total Duration by Provider Id and Date
01CM85 Search Series
01CM86 Associate Title To Series
01CM87 Search Season
01CM88 Add Asset
01CM89 Get Title Id from Document Id
01CM90 Get AssetId and Field Values by AssetType
01CM91 Set Title Properties
01CM92 Advanced Search Title
01CM93 Get Aggregated Distribution Status
01CM94 Has Asset Metadata Changed
01CM96 Get Asset Multiple Values

* The message has been deprecated. Please use the replacement message(s) instead.

NODE DEFINITION DETAILS

This node definition has been deprecated and replaced by node definition 'Get Title Metadata' (01CM23).

Generates the metadata XML document for the most recent revision of a title that is not in draft status using the provided specification format. If there is revision of the title that is not in draft status, the operation fails.

This operation supports generating the metadata XML document in the internal TTV specification format (with specification alias value: 'TTV').

Returns a NACK message if Parent Directory in the outputMetadataFilePath file is invalid

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title for which to generate the metadata XML document.
spec No The alias of the specification to use as the format of the generated metadata XML document.
outputMetadataFilePath No The file path to use to write out the generated metadata XML document.
RESPONSE MESSAGE:
Parameter Name Description / Value
result The result of the operation. Expected value: SUCCESS.

This node definition has been deprecated and replaced by node definition 'Get Original File Properties' (01CM78).

Get the metadata values for a title file asset of file type 'ORIGINAL' given the ID of the title and the ID of the asset that contains the file asset. If the matched title asset does not contain a file asset of file type 'ORIGINAL', the operation fails.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title that contains the file asset.
assetId No The ID of the asset that is the parent of the file asset.
RESPONSE MESSAGE:
Parameter Name Description / Value
aspectratio The value of the aspect ratio metadata field for the matching file asset.
bitrate The value of the bit rate metadata field for the matching file asset.
checksum The value of the checksum metadata field for the matching file asset.
duration The value of the duration metadata field for the matching file asset.
encodeFormat The value of the encode format metadata field for the matching file asset.
encodeProfile The value of the encode profile metadata field for the matching file asset.
fileName The value of the file name metadata field for the matching file asset.
fileSize The value of the file size metadata field for the matching file asset.
fileUri The value of the file URI metadata field for the matching file asset.
height The value of the height metadata field for the matching file asset.
lookupKey The value of the lookup key metadata field for the matching file asset.
materialId The value of the material ID metadata field for the matching file asset.
mimeType The value of the mime type metadata field for the matching file asset.
resolution The value of the resolution metadata field for the matching file asset.
width The value of the width metadata field for the matching file asset.

This node definition has been deprecated and replaced by node definition 'Get Asset Metadata Value' (01CM32).

Gets the value for a metadata field in a title asset given the ID of the title, the type of the asset containing the metadata field, and the name of the metadata field.

If the asset contains multiple assets that match the provided asset type, the first matching asset is used to determine the metadata field value. If the title does not contain an asset that matches the provided asset type, the operation fails.

If the matched asset contains multiple metadata fields that match the provided metadata field name (for fields with cardinality greater than 1), the first matching metadata field value is returned. If the matched asset does not contain a value for the provided metadata field name, a blank value is returned.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title that contains the metadata field to read.
itemType No

The type of the asset that contains the metadata field to read.

Sample values: PACKAGE, MOVIE, POSTER

ttvXPath No The name of the metadata field to read.
RESPONSE MESSAGE:
Parameter Name Description / Value
fieldValue The value for the matched metadata field or blank value if no matching field exists.

This node definition has been deprecated and replaced by node definition 'Nationalize' (01CM18).

Runs the normalization rules on a master title using the 'Ingest' event as the trigger for rule execution, and saves the updated title. If the title fails rules validation when being updated in the repository, the title is saved with draft status.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the master title to normalize.
sourceComponentName No The name of the component reporting the progress information. Expected value: WatchPoint.
sourceEntityName No The name of the component module / entity reporting the progress information. Expected value: Workflow.
sourceId No The identifier for the entity reporting the progress information. Expected value: <PROCESS_ID>|<TOKEN_ID>
  • PROCESS_ID: The work order ID
  • TOKEN_ID: The work order token ID
RESPONSE MESSAGE:
Parameter Name Description / Value
result A boolean value indicating if the title passed rules validation after normalization. Possible values:
  • true: The title passed rules validation after normalization.
  • false: The title failed rules validation after normalization and was saved with draft status.
errorMessage The list of all the title validation messages trimmed to ensure that the total length of this string does not exceed 1024 characters. The value is set only if the title fails rules validation after normalization.

Deletes a title from the repository. If the title has already been deleted, this operation does not fail.

Do not use this message to delete a site title. Use node definition 'Delete Site Title' (01SM02) from the Site Manager resource type instead.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title to delete.
RESPONSE MESSAGE:
There are no response message parameters.
GET ALL FILES (01CM06) [DEPRECATED]

This node definition has been deprecated and has no replacement.

If this node definition is being used to get the list of all content file paths associated with a title so that they can be deleted during the title purge process, please use node definition 'Retire Title' (01CM22) instead.

Gets a comma separated list of all file paths associated with every revision of a title. The value for the file path is read from the file URI metadata field for each file asset associated with the title. The values are read from each revision of the title ensuring that every saved value is returned.

This operation returns the list of file paths even if the title has been deleted.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title for which to get all file paths.
RESPONSE MESSAGE:
Parameter Name Description / Value
listOfFiles A comma separated list of all file paths associated every revision of the title.
GET FILE INFO (01CM07) [DEPRECATED]

This node definition has been deprecated and replaced by node definition 'Get File Properties by Lookup Key' (01CM74).

Get the metadata values for a title file asset with a matching lookup key given the ID of the title containing the file asset and the ID of the asset that the file asset is registered to.

If no matching file asset is found, blank values are returned for all metadata value parameters.

Returns a NACK if the lookupKey is Invalid

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title that contains the file asset.
assetId No The ID of the asset that is the file asset is registered to.
lookupKey No The value to match with the lookup key metadata field for the file asset.
RESPONSE MESSAGE:
Parameter Name Description / Value
result The result of searching for a matching file asset in the title. Possible values:
  • SUCCESS: A matching file asset was found in the title.
  • FAILED: No matching file asset was found in the title.
aspectratio The value of the aspect ratio metadata field for the matching file asset.
bitrate The value of the bit rate metadata field for the matching file asset.
checksum The value of the checksum metadata field for the matching file asset.
duration The value of the duration metadata field for the matching file asset.
encodeFormat The value of the encode format metadata field for the matching file asset.
encodeProfile The value of the encode profile metadata field for the matching file asset.
fileName The value of the file name metadata field for the matching file asset.
fileSize The value of the file size metadata field for the matching file asset.
fileUri The value of the file URI metadata field for the matching file asset.
height The value of the height metadata field for the matching file asset.
materialId The value of the material ID metadata field for the matching file asset.
mimeType The value of the mime type metadata field for the matching file asset.
resolution The value of the resolution metadata field for the matching file asset.
width The value of the width metadata field for the matching file asset.

This node definition has been deprecated and has no replacement. Please use the rules validation feature in CMS to perform validation of title metadata.

Validates a metadata XML document by determining the specification format for the document and executing the validator configured for the specification via the specification plugin.

The operation fails if the specification format cannot be determined or if the document fails validation.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
filepath No The path to the metadata XML document file.
RESPONSE MESSAGE:
There are no response message parameters.

This node definition has been deprecated and has no replacement. Please use the rules validation feature in CMS to perform validation of title metadata.

Validates the generated metadata XML document for a persisted title given the ID of the title and the alias for the specification used when generating the metadata document. The metadata XML document is generated in the specified specification format and the validator configured for that specification via the specification plugin is used to validate the document.

The operation fails if the generated document fails validation.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title to validate using the specification validator.
spec No The alias of the specification used for generating the metadata XML document and providing the validator.
RESPONSE MESSAGE:
There are no response message parameters.

Triggers the 'Ingest' event for a title to the Rule Engine component causing the content processing rules to be to be executed for the title.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title for which to send the 'Ingested' event to the Rule Engine component.
RESPONSE MESSAGE:
There are no response message parameters.

This node definition has been deprecated and replaced by node definition 'Localize' (01CM19).

Runs the normalization rules on a site title using the 'Targeted' event as the trigger for rule execution, and saves the updated title. If the title fails rules validation when being updated in the repository, the title is saved with draft status.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the site title to normalize.
sourceComponentName No The name of the component reporting the progress information. Expected value: WatchPoint.
sourceEntityName No The name of the component module / entity reporting the progress information. Expected value: Workflow.
sourceId No The identifier for the entity reporting the progress information. Expected value: <PROCESS_ID>|<TOKEN_ID>
  • PROCESS_ID: The work order ID
  • TOKEN_ID: The work order token ID
RESPONSE MESSAGE:
Parameter Name Description / Value
result A boolean value indicating if the title passed rules validation after normalization. Possible values:
  • true: The title passed rules validation after normalization.
  • false: The title failed rules validation after normalization and was saved with draft status.
errorMessage The list of all the title validation messages, if the title fails rules validation after normalization.

This node definition has been deprecated and replaced by node definition 'Unregister All Asset Files' (01CM77).

Unregisters / removes all file assets in the asset tree of a title. If the title fails rules validation when being saved after the file assets are removed, the title is saved with draft status.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title for which to unregister all file assets.
sourceComponentName No The name of the component reporting the progress information. Expected value: WatchPoint.
sourceEntityName No The name of the component module / entity reporting the progress information. Expected value: Workflow.
sourceId No The identifier for the entity reporting the progress information. Expected value: <PROCESS_ID>|<TOKEN_ID>
  • PROCESS_ID: The work order ID
  • TOKEN_ID: The work order token ID
RESPONSE MESSAGE:
There are no response message parameters.

Generates the title metadata XML in the internal ECMF specification format to the specified output file.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title to generate in the internal ECMF specification format.
outputFilePath No The path to the file to use when writing out the title metadata XML document.
RESPONSE MESSAGE:
There are no response message parameters.

Runs the normalization rules on a master title using the 'Ingest' event as the trigger for rule execution, and saves the updated title. If the title fails rules validation when being updated in the repository, the title is saved with draft status.

If there are any normalization rules that use metadata enhancement profiles, then they will be applied as well if the title matches the conditions defined in the ruleset. If for an enahncement normalization rule there is no matching results for this title from the 3PP then the ME rules evaluation will be skipped.

The operation fails if the ID of a site title is provided for normalization.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the master title to normalize.
RESPONSE MESSAGE:
Parameter Name Description / Value
titleStatus The status of the title after normalization. Possible values:
  • DRAFT
  • COMMITTED
  • READY
isValid A boolean value indicating if the title passed validation after normalization. Possible values:
  • true: The title passed validation after normalization.
  • false: The title failed validation after normalization and was saved with draft status.
validationMessages The list of all the title validation messages trimmed to ensure that the total length of this string does not exceed 2048 characters. The value is set only if the title fails rules validation after normalization.

Runs the normalization rules on a site title using the 'Target' event as the trigger for rule execution, and saves the updated title. If the title fails rules validation when being updated in the repository, the title is saved with draft status.

If there are any normalization rules that use metadata enhancement profiles, then they will be applied as well if the title matches the conditions defined in the ruleset. If for an enahncement normalization rule there is no matching results for this title from the 3PP then the ME rules evaluation will be skipped.

The operation fails if the ID of a master title is provided for normalization.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the site title to normalize.
RESPONSE MESSAGE:
Parameter Name Description / Value
titleStatus The status of the title after normalization. Possible values:
  • DRAFT
  • COMMITTED
  • READY
isValid A boolean value indicating if the title passed validation after normalization. Possible values:
  • true: The title passed validation after normalization.
  • false: The title failed validation after normalization and was saved with draft status.
validationMessages The list of all the title validation messages trimmed to ensure that the total length of this string does not exceed 2048 characters. The value is set only if the title fails rules validation after normalization.

Validates a title using the validation rules (and other registered validators).

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title to validate.
RESPONSE MESSAGE:
Parameter Name Description / Value
isValid A boolean value indicating if the title passed validation. Possible values:
  • true: The title passed validation.
  • false: The title failed validation.
message The list of all the title validation messages trimmed to ensure that the total length of this string does not exceed 2048 characters. The value is set only if the title fails validation.

Retires a title which may have been previously deleted. The retirement process for a title involves the following steps:

  • Search every revision of the title for the values of the file URI metadata field in the file assets of the title. Delete each of these file paths that exist and are accessible from the file system. The operation does not fail if any of the file paths cannot be deleted.
  • Delete all generated resource files for the title from the file system (thumbnails, key frames, etc.).
  • Update the title retirement date.
  • If the title has not been deleted, change the title status to 'RETIRED' and remove all file assets from the title's asset tree.
REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title to retire.
RESPONSE MESSAGE:
There are no response message parameters.

Generates the metadata XML document for the most recent revision of a title that is not in draft status using the provided specification format. If there is revision of the title that is not in draft status, the operation fails.

This operation does not support generating the metadata XML document in the internal specification formats (TTV and ECMF). Please use node definition 'Get Title' (01CM16) to generate the title metadata in the ECMF specification format. Generating the title metadata in the TTV specification format is no longer supported.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title for which to generate the metadata XML document.
specification No The alias of the specification to use as the format of the generated metadata XML document.
outputFilePath No The file path to use to write out the generated metadata XML document.
RESPONSE MESSAGE:
Parameter Name Description / Value
isCurrentVersion A boolean value indicating if the metadata XML document is generated from the current revision of the title. Possible values:
  • true: The current revision was used.
  • false: An older revision was used because the current revision is in draft status.
version The revision of the title selected when generating the metadata XML document.

Gets the value of the status for a title which may have been previously deleted.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title for which to get the status.
RESPONSE MESSAGE:
Parameter Name Description / Value
status The current status of the title. Possible values:
  • DRAFT
  • COMMITTED
  • READY
  • RETIRED
  • DELETED

Gets the value set for a property of the title. The title may have been previously deleted.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title for which to get the property value.
propertyName No The name of the property for which to get the property value.
RESPONSE MESSAGE:
Parameter Name Description / Value
propertyValue The value set for the property or empty string if no value has been set.

Sets the value for a property or deletes a property of the title. Setting the value to a blank string causes the property to be deleted for the title. The title may have been previously deleted.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title for which to set the property value.
propertyName No The name of the property for which to set the value.
propertyValue Yes The value to set for the property. A blank value will delete the property.
RESPONSE MESSAGE:
There are no response message parameters.

Gets the values set for upto 5 different properties of the title. The title may have been previously deleted.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title for which to get the property values.
propertyName1 No The name of the first property for which to get the property value.
propertyName2
propertyName3
propertyName4
propertyName5
Yes

The name of the property for which to get the property value. A blank value for the property name indicates that the corresponding property value does not need to be read.

The number at the end of the parameter name is used as an index identifier that is also attached to the corresponding response message parameter for the property value.

RESPONSE MESSAGE:
Parameter Name Description / Value
propertyValue1
propertyValue2
propertyValue3
propertyValue4
propertyValue5
The corresponding value set for the property or empty string if no value has been set or the corresponding property name is blank.

Gets the ID of the first asset in the asset tree for a title that matches the provided asset type. The 'FILE' asset type is not supported. The title may have been previously deleted.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title which contains the asset to match.
assetType No

The asset type value to match with the title assets.

Sample values: PACKAGE, MOVIE, POSTER. Please check section A. of the appendix for all supported asset type values.

RESPONSE MESSAGE:
Parameter Name Description / Value
assetId The ID of the first asset in the title asset tree that matches the asset type, or blank value if there are no matching assets.

Gets a comma separated list of IDs of assets in the asset tree for a title that match the provided asset type. The 'FILE' asset type is not supported. The title may have been previously deleted.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title which contains the assets to match.
assetType No

The asset type value to match with the title assets.

Sample values: PACKAGE, MOVIE, POSTER. Please check section A. of the appendix for all supported asset type values.

RESPONSE MESSAGE:
Parameter Name Description / Value
assetIdList The comma separated list of IDs of assets in the title asset tree that match the asset type. A blank value is returned if there are no matching assets.

Get the IDs for the first matching asset for each of the provided asset type values. The 'FILE' asset type value is not supported. The title may have been previously deleted.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title which contains the assets to match.
assetType1 No

The first asset type value to match against the title assets.

Sample values: PACKAGE, MOVIE, POSTER. Please check section A. of the appendix for all supported asset type values.

assetType2
assetType3
assetType4
assetType5
assetType6
assetType7
assetType8
Yes

The asset type value to match against the title assets. A blank asset type value indicates that no corresponding asset ID needs to be matched and returned.

Sample values: PACKAGE, MOVIE, POSTER. Please check section A. of the appendix for all supported asset type values.

RESPONSE MESSAGE:
Parameter Name Description / Value
assetId1
assetId2
assetId3
assetId4
assetId5
assetId6
assetId7
assetId8
The ID of the first asset in the title asset tree that matches the corresponding asset type value. A blank value is returned if no matching asset exists, or if the corresponding asset type value is blank.

Gets the basic details for an asset in the title asset tree given the ID of the title and the ID of the asset. The title may have been previously deleted.

The operation fails if no matching asset is found in the title asset tree, or if the matched asset is of 'FILE' asset type.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title which contains the asset for which to read the details.
assetId No The ID of the asset for which to read the details.
RESPONSE MESSAGE:
Parameter Name Description / Value
assetType

The type of the matched asset.

Please check section A. of the appendix for all supported asset type values.

parentAssetId The ID of the parent asset of the matched asset in the title asset tree. If the matched asset is the root asset (has no parent asset), a blank value is returned.
parentAssetType

The asset type of the parent asset of the matched asset in the title asset tree. If the matched asset is the root asset (has no parent asset), a blank value is returned.

Please check section A. of the appendix for all supported asset type values.

Gets the value of a metadata field in an asset in a title. The title may have been previously deleted.

For a metadata field with multiple values, the first value assigned is returned. This operation does not support getting all the values assigned for a metadata field.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title which contains the metadata value to read.
assetId No The ID of the asset which contains the metadata value to read.
field No The name or alias of the metadata field for which to read the metadata value.
RESPONSE MESSAGE:
Parameter Name Description / Value
value The first value assigned for the metadata field. If no value has been assigned for the field, a blank value is returned.

Gets the values for up to 10 different metadata fields in an asset in a title. The title may have been previously deleted.

For each of the metadata fields, only the first value assigned to the field is returned. This operation does not support getting all the values assigned for a metadata field.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title which contains the metadata values to read.
assetId No The ID of the asset which contains the metadata values to read.
field1 No The name or alias of the first metadata field for which to read the metadata value.
field2
field3
field4
field5
field6
field7
field8
field9
field10
Yes The name or alias of the metadata field for which to read the metadata value. A blank value indicates that no corresponding metadata field value will be returned.
RESPONSE MESSAGE:
Parameter Name Description / Value
value1
value2
value3
value4
value5
value6
value7
value8
value9
value10
The first value assigned for the corresponding metadata field. A blank value is returned if no value has been assigned for the field or if the corresponding metadata field name / alias is blank.

Sets the value for a metadata field for an asset in a title.

If the metadata field has multiple values assigned, the first value is overwritten with the new value provided. This operation does not support setting multiple values for a metadata field.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title for which to write the metadata value.
assetId No The ID of the asset for which to write the metadata value.
ttvPath No The name or alias of the metadata field for which to write the metadata value.
value Yes The metadata value to write for the metadata field in the title asset. A blank value will delete the first value assigned for the metadata field.
RESPONSE MESSAGE:
There are no response message parameters.

Sets the values for up to 10 different metadata fields for an asset in a title.

For each of the metadata fields, only the first value assigned to the field can be set. This operation does not support setting multiple values for a metadata field.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title for which to write the metadata values.
assetId No The ID of the asset for which to write the metadata values.
field1 No The name or alias of the first metadata field for which to write the metadata value.
field2
field3
field4
field5
field6
field7
field8
field9
field10
Yes The name or alias of the metadata field for which to write the metadata value. A blank value indicates that the metadata field value does not need to be set.
value1
value2
value3
value4
value5
value6
value7
value8
value9
value10
Yes The value to set for the corresponding metadata field. A blank value will delete the first value assigned for the corresponding metadata field. If the corresponding metadata field name / alias is blank, the value is ignored.
RESPONSE MESSAGE:
There are no response message parameters.

Searches the title repository for a master title that matches the specified metadata XML file. The master title is matched against the metadata XML document based on the keys defined for the specification that the metadata XML document conforms to.

If the metadata XML document does not contain a valid key based on the specification that the metadata XML document conforms to, the operation indicates that no matching master title exists. It is not possible to have multiple matching master titles for a metadata XML document since all valid specification keys are always unique in the application.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
metadataPath No The path to the metadata XML file to match.
RESPONSE MESSAGE:
Parameter Name Description / Value
matchType The result of the operation that indicates the type of the match made. Possible values:
  • NO_MATCH: No matching master title was found in the repository. A new title can be created for the metadata document.
  • UNIQUE_MATCH: A single matching master title was found in the the repository. This title must be updated for the metadata document.
matchCount The number of matching master titles. Possible values: 0, 1.
titleId The ID of the master title that matches the metadata XML document, or blank value if no match was found.
assetId The ID of the root asset in the title asset tree that the metadata XML file will be registered for when the title is updated for the metadata XML document. If no matching title was found, a blank value is returned.

Creates a new master title for the package being ingested. The package must be in the form of a folder that contains all the package contents. If the title fails rules validation when being created in the repository, the title is saved with draft status.

The title is first created with the package metadata XML document. The package content files are then registered with the title assets by matching the content file names with the asset metadata. The metadata XML file is always automatically registered with the root asset of the title.

Package content files that do not match a title asset remain unregistered. Similarly, title assets that refer to a content file that is not present in the package are not mapped with a content file.

The operations fails if no source partner (or self partner) exists which has a provider ID value that matches the specified provider ID value. If the optional content class name is left blank, the title is created with the 'Default' content class.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
metadataPath No The path to the package metadata XML file.
assetFolderPath No The path to the folder that contains the package content files.
providerId No The provider ID for the source partner / self partner that provides the package. The title is created for this partner.
contentClassName Yes The name of the content class to apply when creating the title. A blank value indicates that the 'Default' content class will be applied.
RESPONSE MESSAGE:
Parameter Name Description / Value
titleId The ID of the created title.
metadataAssetId The ID of the title asset that the metadata XML file is registered to. This is normally the root asset of the title.
metadataFileId The ID of the file asset created for the metadata XML file.
contentAssetIds A comma separated list of the IDs of title assets that have a package content file registered / mapped.
contentAssetMappingCount The number of title assets that have a package content file registered / mapped.
unmappedFilePaths A comma separated list of paths for content files in the package folder that are not registered with a title asset.
unmappedFileCount The number of content files in the package folder that are not registered with a title asset.
validationStatus A boolean value indicating the validation status of the title being created. Possible values:
  • true: The title passed rules validation after being created.
  • false: The title failed rules validation after being created, and is saved with draft status.

Updates an existing new master title for the package being ingested. The package must be in the form of a folder that contains all the package contents. If the title fails rules validation when being updated in the repository, the title is saved with draft status.

The title is first updated with the package metadata XML document. The package content files are then registered with the title assets by matching the content file names with the asset metadata. The metadata XML file is always automatically registered with the root asset of the title.

Package content files that do not match a title asset remain unregistered. Similarly, title assets that refer to a content file that is not present in the package are not mapped with a content file.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
metadataPath No The path to the package metadata XML document file.
assetFolderPath No The path to the folder that contains the package content files.
titleId No The ID of the title to update for the package being ingested.
RESPONSE MESSAGE:
Parameter Name Description / Value
metadataAssetId The ID of the title asset that the metadata XML file is registered to. This is normally the root asset of the title.
metadataFileId The ID of the file asset created for the metadata XML file.
contentAssetIds A comma separated list of the IDs of title assets that have a package content file registered / mapped.
contentAssetMappingCount The number of title assets that have a package content file registered / mapped.
unmappedFilePaths A comma separated list of paths for content files in the package folder that are not registered with a title asset.
unmappedFileCount The number of content files in the package folder that are not registered with a title asset.
validationStatus A boolean value indicating the validation status of the title being updated. Possible values:
  • true: The title passed rules validation after being updated.
  • false: The title failed rules validation after being updated, and is saved with draft status.
plannerId The ID of the planner, if this title is associated with an upcoming planner.

Creates a new master title for the metadata XML file being ingested. If the title fails rules validation when being created in the repository, the title is saved with draft status.

The operations fails if no source partner (or self partner) exists which has a provider ID value that matches the specified provider ID value. If the optional content class name is left blank, the title is created with the 'Default' content class.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
metadataPath No The path to the metadata XML file being ingested.
providerId No The provider ID for the source partner that the title is created for.
contentClassName Yes The name of the content class to apply when creating the title. A blank value indicates that the 'Default' content class will be applied.
RESPONSE MESSAGE:
Parameter Name Description / Value
titleId The ID of the created title.
metadataAssetId The ID of the title asset that the metadata XML file is registered to. This is normally the root asset of the title.
metadataFileId The ID of the file asset created for the metadata XML file.
validationStatus A boolean value indicating the validation status of the title being created. Possible values:
  • true: The title passed rules validation after being created.
  • false: The title failed rules validation after being created, and is saved with draft status.

Updates an existing master title for the metadata XML file being ingested. If the title fails rules validation when being updated in the repository, the title is saved with draft status.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
metadataPath No The path to the package metadata XML document file.
titleId No The ID of the title to update for the package being ingested.
RESPONSE MESSAGE:
Parameter Name Description / Value
metadataAssetId The ID of the title asset that the metadata XML file is registered to. This is normally the root asset of the title.
metadataFileId The ID of the file asset created for the metadata XML file.
validationStatus A boolean value indicating the validation status of the title being updated. Possible values:
  • true: The title passed rules validation after being updated.
  • false: The title failed rules validation after being updated, and is saved with draft status.
plannerId The ID of the planner, if this title is associated with an upcoming planner.

Searches the title repository for assets that belong to master titles that match the specified content file being ingested. The title assets are matched with the content file based on the asset metadata matching the specified provider ID and the content file name.

The search may produce three different results:

  • No matching title asset is found. The user may move the ingested content file to the unmapped content repository.
  • A unique matching title asset is found. The user may update the matched title asset with the content file being ingested.
  • Multiple matching title assets are found. The user may require a manual task to select the title asset that can be updated with the content file being ingested.
REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
assetPath No The path to the content file.
providerId No The provider ID for the source partner that provides the content file. This value is used as a search filter when searching for matching master title assets.
RESPONSE MESSAGE:
Parameter Name Description / Value
matchType The type of the match made when searching for title assets. Possible values:
  • NO_MATCH: No matching title asset was found.
  • UNIQUE_MATCH: A single (unique) matching title asset was found.
  • DUPLICATE_MATCHES: Multiple matching title assets were found.
matchCount The number of matching title assets that were found.
titleId The ID of the master title that was matched if a unique match was found. A blank value is returned otherwise.
assetId The ID of the title asset that was matched if a unique match was found. A blank value is returned otherwise.

Performs an update on the master title by registering the specified content file being ingested with the matching title asset. The title asset is matched with the content file by matching the the content file name with the asset metadata.

The operation fails if no matching title asset is found or if multiple matching title assets are found. If the title fails rules validation when being updated in the repository, the title is saved with draft status.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
assetPath No The path to the content file being ingested.
titleId No The ID of the title to update for the ingested content file.
RESPONSE MESSAGE:
Parameter Name Description / Value
assetId The ID of the title asset that the content file is registered for.
assetType

The asset type of the title asset that the content file is registered for.

Please see section A. of the appendix for all supported asset type values.

fileId The ID of the file asset created for the registered content file.
validationStatus A boolean value indicating the validation status of the title being updated. Possible values:
  • true: The title passed rules validation after being updated.
  • false: The title failed rules validation after being updated, and is saved with draft status.
plannerId The ID of the planner, if this title is associated with an upcoming planner.

Registers a new key frames folder path for an asset in a title.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title for which to register the new key frames folder path.
assetId No The ID of the title asset for which to register the new key frames folder path.
keyFramesPath No The path to the key frames folder being registered.
RESPONSE MESSAGE:
There are no response message parameters.

Registers a new still image file path for an asset in a title.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title for which to register the new still image file path.
assetId No The ID of the title asset for which to register the new still image file path.
imagePath No The path to the still image file being registered.
RESPONSE MESSAGE:
There are no response message parameters.

Generates the URL to use as the external URL in the manual task to fix the validation errors for a title.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title for which to generate the manual task external URL.
RESPONSE MESSAGE:
Parameter Name Description / Value
urlToFixTitle The generated URL to use as the external URL in the manual task to fix validation errors for the title.

Generates the URL to use as the external URL in the manual task to perform the manual mapping of unmapped content files to one or more assets in a title.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title for which to generate the manual task external URL.
listOfAssetIds No The comma separated list of IDs of title assets which require manual mapping to unmapped content files.
RESPONSE MESSAGE:
Parameter Name Description / Value
urlForTitleAssetMapping The generated URL to use as the external URL in the manual task to perform manual mapping of unmapped content files to the specified title asset(s).

Generates the URL to use as the external URL in the manual task to perform the mapping of a title asset to the incoming / ingested content file. The manual task involves allowing the to search for and to select a title asset that the ingested content file can be registered under.

REQUEST MESSAGE:
There are no request message parameters.
RESPONSE MESSAGE:
Parameter Name Description / Value
urlForTitleMappingCompletion The generated URL to use as the external URL in the manual task to perform selection of a title asset that the ingested content file can be registered under.

Adds new progress information for a title to enable monitoring of the actions performed on the title. The progress information is for a particular action performed on the title and can be viewed on the title history page.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title for which the progress information is being added.
scheduleId Yes The ID of the planner or pitch schedule that the title and the progress information is associated with.
status No The status name for the progress information that describes the action performed, e.g.: MOVIE RECEIVED.
success No A boolean value indicating if the action was performed on the title was successful:
  • true
  • false
value Yes A detailed description of the action performed on the title.
RESPONSE MESSAGE:
There are no response message parameters.

Gets the value of a metadata custom field in an asset in a title. The title may have been previously deleted.

For a metadata custom field with multiple values, the first value assigned is returned. This operation does not support getting all the values assigned for a metadata custom field.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title which contains the metadata custom field value to read.
assetId No The ID of the asset which contains the metadata custom field value to read.
field No

The name of the custom field for which to read the value.

Do not use the complete name of the field, just the name of the custom field. For example, for field: /Fields/CustomFields/CustomField[@name=ArchiveType]/@value use the name: ArchiveType to get the custom field value.

RESPONSE MESSAGE:
Parameter Name Description / Value
value The first value assigned for the metadata custom field. If no value has been assigned for the custom field, a blank value is returned.

Gets the values for up to 10 different metadata custom fields in an asset in a title. The title may have been previously deleted.

For each of the metadata custom fields, only the first value assigned to the field is returned. This operation does not support getting all the values assigned for a metadata custom field.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title which contains the metadata custom field values to read.
assetId No The ID of the asset which contains the metadata custom field values to read.
field1 No

The name of the first custom field for which to read the value.

Do not use the complete name of the field, just the name of the custom field. For example, for field: /Fields/CustomFields/CustomField[@name=ArchiveType]/@value use the name: ArchiveType to get the custom field value.

field2
field3
field4
field5
field6
field7
field8
field9
field10
Yes

The name of the custom field for which to read the value. A blank value indicates that no corresponding metadata custom field value will be returned.

Do not use the complete name of the field, just the name of the custom field. For example, for field: /Fields/CustomFields/CustomField[@name=ArchiveType]/@value use the name: ArchiveType to get the custom field value.

RESPONSE MESSAGE:
Parameter Name Description / Value
value1
value2
value3
value4
value5
value6
value7
value8
value9
value10
The first value assigned for the corresponding metadata custom field. A blank value is returned if no value has been assigned for the metadata custom field or if the corresponding metadata custom field name is blank.

Sets the value for a metadata custom field for an asset in a title.

If the metadata custom field has multiple values assigned, the first value is overwritten with the new value provided. This operation does not support setting multiple values for a metadata custom field.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title for which to write the metadata custom field value.
assetId No The ID of the asset for which to write the metadata custom field value.
field No

The name of the custom field for which to write the value.

Do not use the complete name of the field, just the name of the custom field. For example, for field: /Fields/CustomFields/CustomField[@name=ArchiveType]/@value use the name: ArchiveType to get the custom field value.

value Yes The value to write for the metadata custom field in the title asset. A blank value will delete the first value assigned for the metadata custom field.
RESPONSE MESSAGE:
There are no response message parameters.

Sets the values for up to 10 different metadata custom fields for an asset in a title.

For each of the metadata fields, only the first value assigned to the custom field can be set. This operation does not support setting multiple values for a metadata custom field.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title for which to write the metadata custom field values.
assetId No The ID of the asset for which to write the metadata custom field values.
field1 No

The name of the first custom field for which to write the value.

Do not use the complete name of the field, just the name of the custom field. For example, for field: /Fields/CustomFields/CustomField[@name=ArchiveType]/@value use the name: ArchiveType to get the custom field value.

field2
field3
field4
field5
field6
field7
field8
field9
field10
Yes

The name of the custom field for which to write the value. A blank value indicates that the metadata custom field value does not need to be set.

Do not use the complete name of the field, just the name of the custom field. For example, for field: /Fields/CustomFields/CustomField[@name=ArchiveType]/@value use the name: ArchiveType to get the custom field value.

value1
value2
value3
value4
value5
value6
value7
value8
value9
value10
Yes The value to set for the corresponding metadata custom field. A blank value will delete the first value assigned for the corresponding metadata custom field. If the corresponding metadata custom field name is blank, the value is ignored.
RESPONSE MESSAGE:
There are no response message parameters.

Gets the list of IDs of all registered file assets for the specified asset in the specified title.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title that contains the asset for which to get the IDs of registered file assets.
assetId No The ID of the title asset for which to get the IDs of all registered file assets.
RESPONSE MESSAGE:
Parameter Name Description / Value
fileIdList A comma separated list of the IDs of all file assets registered for the matching title asset.

Generates an unmapped content file path that can be used when a content file cannot be mapped to any title asset during the ingest process and must be moved to the unmapped content repository.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
contentFilePath No The path to the content file that needs to be moved to the unmapped content repository.
providerId No The provider ID for the source partner that provides the content file.
RESPONSE MESSAGE:
Parameter Name Description / Value
unmappedContentPath The file path that can be used when moving / copying the content file to the unmapped content repository.

Gets the list of IDs of all assets in the title that are associated with a content file based on the asset metadata.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title for which to get the IDs of all content assets.
RESPONSE MESSAGE:
Parameter Name Description / Value
contentAssetIdList A comma separated list of IDs of title assets that are associated with a content file.
contentAssetCount The count of the content assets in the title.

Gets the path to the metadata XML file in the package given the package folder path.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
packageFolderPath No The path to the package folder that contains all the contents of the package.
RESPONSE MESSAGE:
Parameter Name Description / Value
metadataPath The path to the metadata XML file of the package.

Registers the content file being ingested as the 'ORIGINAL' file asset for the specified asset in the title. The content file is associated with the selected title asset.

If the title fails rules validation when being updated in the repository, the title is saved with draft status.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
assetPath No The path to the content file being ingested.
titleId No The ID of the title containing the asset that the content file is being associated with.
assetId No The ID of the title asset that the ingested content file is being associated with.
registerPathOnly YES A boolean value indicating the file related operations. Possible values:
  • true: just register the file path to the asset only, skip moving the file if it is in the unmapped folder and don’t calculate file size.
  • false: not only register the file path to the asset, but also involve the file related operations like file move and file size.
  • Blank: treat it false as default value.
RESPONSE MESSAGE:
Parameter Name Description / Value
assetType

The type of the asset that the content file is associated with.

Please check section A. of the appendix for all supported asset type values.

fileId The ID of the new file asset created for the registered content file.
validationStatus A boolean value indicating the validation status of the title after the content file is registered. Possible values:
  • true: The title passed rules validation after being updated.
  • false: The title failed rules validation after being updated, and is saved with draft status.
plannerId The ID of the planner, if this title is associated with an upcoming planner.

Performs a content search on the title repository for the IDs of titles that match the specified search criteria. The search criteria is made of up to 5 different metadata fields with an 'AND' condition applied to the applicable criteria. The search is performed only on master titles.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
field1Xpath No The name or alias of the metadata field to match as the first search criteria condition.
field1AssetType No

The complete path of asset types to the asset to match as the first search criteria condition. The complete path uses the '/' character as a separator.

For example, to search for a metadata field in the 'MOVIE' asset under the 'PACKAGE' asset, the complete path value would be: PACKAGE/MOVIE

Please check section A. of the appendix for all supported asset type values.

field1Value No The value to match for the metadata field as the first search criteria condition.
field2Xpath
field3Xpath
field4Xpath
field5Xpath
Yes The name or alias of the metadata field to match as a search criteria condition. A blank value indicates that this condition should not be included in the search criteria.
field2AssetType
field3AssetType
field4AssetType
field5AssetType
Yes

The complete path of asset types to the asset to match as the a search criteria condition. The complete path uses the '/' character as a separator. If the corresponding fieldXpath parameter value is blank, this value is ignored and not added as a search criteria condition. This value should NOT be blank if the corresponding fieldXpath parameter value is not blank.

For example, to search for a metadata field in the 'MOVIE' asset under the 'PACKAGE' asset, the complete path value would be: PACKAGE/MOVIE

Please check section A. of the appendix for all supported asset type values.

field2Value
field3Value
field4Value
field5Value
Yes The value to match for the metadata field as a search criteria condition. If the corresponding fieldXpath parameter value is blank, this value is ignored and not added as a search criteria condition. This value should NOT be blank if the corresponding fieldXpath parameter value is not blank.
RESPONSE MESSAGE:
Parameter Name Description / Value
titleIds A comma separated list of the IDs of master titles that match the search criteria.
matchingTitleCount The number of master titles that match the search criteria.

This node definition has been deprecated and replaced by node definition 'Update Title for Metadata' (01CM41).

Updates an existing master title with the metadata XML file being ingested. If the title fails rules validation when being updated in the repository, the title is saved with draft status.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
metadataFilePath No The path to the metadata XML file to ingest.
titleId No The ID of the master title to merge / update with the metadata XML file.
sourceComponentName No The name of the component reporting the progress information. Expected value: WatchPoint.
sourceEntityName No The name of the component module / entity reporting the progress information. Expected value: Workflow.
sourceId No The identifier for the entity reporting the progress information. Expected value: <PROCESS_ID>|<TOKEN_ID>
  • PROCESS_ID: The work order ID
  • TOKEN_ID: The work order token ID
RESPONSE MESSAGE:
Parameter Name Description / Value
validationSucceeded A boolean value indicating if the title passes rules validation after being updated. Possible values:
  • true: The title passed rules validation after being updated.
  • false: The title failed rules validation after being updated and was saved with draft status.

Exports a title list and its contents to a specified file.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleListId No The ID of the title list to export.
dirPath No The path to the folder in which the file containing the exported title list is written.
RESPONSE MESSAGE:
Parameter Name Description / Value
filePath The path to the file containing the exported title list.

Gets all unmapped content file paths that match the metadata for a title asset.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title that contains the asset for which to search for unmapped content file paths.
assetId No The ID of the asset for which to search for unmapped content file paths.
RESPONSE MESSAGE:
Parameter Name Description / Value
filePaths A comma separated list of file paths for the unmapped content files that match the title asset metadata.
fileCount A count of the unmapped content files that match the title asset metadata.

Gets the list of the IDs of each asset present in a title list in the order that the title list defines.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleListId No The ID of the title list for which to get the IDs of the contained assets.
RESPONSE MESSAGE:
Parameter Name Description / Value
assetIdList A comma separated list of the IDs of each asset contained in the title list in the order specified by the title list.

Gets the list of the IDs of each title that contains an asset present in a title list. If a title contains multiple assets in a title list, the returned list will contain only one entry for the title ID. The order of the title IDs in the returned list is the same as the ordering defined for the contained assets in the title list.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleListId No The ID of the title list for which to get the IDs of the contained titles.
RESPONSE MESSAGE:
Parameter Name Description / Value
titleIdList A comma separated list of the IDs of titles that contain an asset that is part of the title list. The list of IDs contains unique values, and maintains the order defined by the title list.

Get the metadata / properties for a file asset that has a matching lookup key metadata field value and is registered registered for a specified asset in the specified title. The title may have been previously deleted.

If no matching file asset is found, blank values are returned for all properties.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title which contains the file asset for which to get properties.
assetId No The ID of the title asset under which the file asset is registered.
lookupKey No The lookup key value to match against the registered file assets for the title asset.
RESPONSE MESSAGE:
Parameter Name Description / Value
fileId The ID of the matching file asset, or blank value if no matching file asset was found.
aspectratio The value for the aspect ratio metadata field for the matching file asset, or blank value if matching asset was found.
bitrate The value for the bit rate metadata field for the matching file asset, or blank value if matching asset was found.
checksum The value for the checksum metadata field for the matching file asset, or blank value if matching asset was found.
duration The value for the duration metadata field for the matching file asset, or blank value if matching asset was found.
encodeFormat The value for the encode format metadata field for the matching file asset, or blank value if matching asset was found.
encodeProfile The value for the encode profile metadata field for the matching file asset, or blank value if matching asset was found.
fileName The value for the file name metadata field for the matching file asset, or blank value if matching asset was found.
fileSize The value for the file size metadata field for the matching file asset, or blank value if matching asset was found.
fileType The value for the file type metadata field for the matching file asset, or blank value if matching asset was found.
fileUri The value for the file URI metadata field for the matching file asset, or blank value if matching asset was found.
height The value for the height metadata field for the matching file asset, or blank value if matching asset was found.
materialId The value for the material ID metadata field for the matching file asset, or blank value if matching asset was found.
mimeType The value for the mime type metadata field for the matching file asset, or blank value if matching asset was found.
resolution The value for the resolution metadata field for the matching file asset, or blank value if matching asset was found.
width The value for the width metadata field for the matching file asset, or blank value if matching asset was found.
result The result of the operation. Possible values:
  • SUCCESS: A matching file asset was found.
  • FAILED: No matching file asset was found.

Sets the metadata / properties for a file asset in a title. If the title fails rules validation when being updated in the repository, the title is saved with draft status.

A blank value specified for any file property indicates that the previous value for that property should remain unchanged. It is not possible to set the file property value to a blank value.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title which contains the file asset for which to set the file properties.
fileId No The ID of the file asset for which to set the file properties.
aspectratio Yes The value to set for the aspect ratio metadata field for the matching file asset. A blank value indicates that the current metadata field value remains unchanged.
bitrate Yes The value to set for the bit rate metadata field for the matching file asset. A blank value indicates that the current metadata field value remains unchanged.
checksum Yes The value to set for the checksum metadata field for the matching file asset. A blank value indicates that the current metadata field value remains unchanged.
duration Yes The value to set for the duration metadata field for the matching file asset. A blank value indicates that the current metadata field value remains unchanged.
encodeFormat Yes The value to set for the encode format metadata field for the matching file asset. A blank value indicates that the current metadata field value remains unchanged.
encodeProfile Yes The value to set for the encode profile metadata field for the matching file asset. A blank value indicates that the current metadata field value remains unchanged.
fileName Yes The value to set for the file name metadata field for the matching file asset. A blank value indicates that the current metadata field value remains unchanged.
fileSize Yes The value to set for the file size metadata field for the matching file asset. A blank value indicates that the current metadata field value remains unchanged.
height Yes The value to set for the height metadata field for the matching file asset. A blank value indicates that the current metadata field value remains unchanged.
lookupKey Yes

The value to set for the lookup key metadata field for the matching file asset. A blank value indicates that the current metadata field value remains unchanged.

If the value is not blank, the application ensures that no other file asset registered for the same title asset has the same value set for the lookup key metadata field. If another such file asset exists, the lookup key metadata field value for that file asset is made blank.

materialId Yes The value to set for the material ID metadata field for the matching file asset. A blank value indicates that the current metadata field value remains unchanged.
mimeType Yes The value to set for the mime type metadata field for the matching file asset. A blank value indicates that the current metadata field value remains unchanged.
resolution Yes The value to set for the resolution metadata field for the matching file asset. A blank value indicates that the current metadata field value remains unchanged.
width Yes The value to set for the width metadata field for the matching file asset. A blank value indicates that the current metadata field value remains unchanged.
RESPONSE MESSAGE:
Parameter Name Description / Value
result The result of the operation. Expected value: SUCCESS.

Registers / creates a new file asset of file type 'DERIVED' for a title. The properties of the file asset can be (optionally) set when the file asset is being registered. The ID of the parent file asset under which the new file asset is created must also be specified.

If the title fails rules validation when being updated in the repository after the new derived file is created, the title is saved with draft status.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title for which to register the derived file asset.
originalFileId No The ID of the file asset that the new derived file asset is created as a child of.
aspectratio Yes The value of the aspect ratio metadata field for the derived file asset.
bitrate Yes The value of the bit rate metadata field for the derived file asset.
checksum Yes The value of the checksum metadata field for the derived file asset.
duration Yes The value of the duration metadata field for the derived file asset.
encodeFormat Yes The value of the encode format metadata field for the derived file asset.
encodeProfile Yes The value of the encode profile metadata field for the derived file asset.
fileName Yes The value of the file name metadata field for the derived file asset.
fileSize Yes The value of the file size metadata field for the derived file asset. If a blank value is specified, the application will attempt to determine the file size of the file system (when possible) and set the file size metadata field.
fileURI No The value for the file URI metadata field for the derived file asset.
height Yes The value for the height metadata field for the derived file asset.
lookupKey Yes

The value for the lookup key metadata field for the derived file asset.

If the value is not blank, the application ensures that no other file asset registered for the same title asset has the same value set for the lookup key metadata field. If another such file asset exists, the lookup key metadata field value for that file asset is made blank.

materialId Yes The value for the material ID metadata field for the derived file asset.
mimeType Yes The value for the mime type metadata field for the derived file asset.
resolution Yes The value for the resolution metadata field for the derived file asset.
width Yes The value for the width metadata field for the derived file asset.
RESPONSE MESSAGE:
Parameter Name Description / Value
derivedFileId The ID of the new derived file asset.
result The result of the operation. Expected value: SUCCESS.

Removes all file assets from the asset tree for a title. If the title fails rules validation when being updated in the repository after the files assets have been removed, the title is saved with draft status.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title for which remove all file assets.
RESPONSE MESSAGE:
There are no response message parameters.

Gets the metadata / properties for a file asset of file type 'ORIGINAL' that is registered for a specified asset in the specified title. The title may have been previously deleted.

If the specified asset does not contain a file asset of file type 'ORIGINAL', blank values are returned for all properties.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title which contains the file asset for which to get the properties.
assetId No The ID of the asset that contains the file asset for which to get the properties.
RESPONSE MESSAGE:
Parameter Name Description / Value
fileId The ID of the matching file asset, or blank value if no matching file asset was found.
aspectratio The value for the aspect ratio metadata field for the matching asset, or blank value if no matching file asset was found.
bitrate The value for the bit rate metadata field for the matching asset, or blank value if no matching file asset was found.
checksum The value for the checksum metadata field for the matching asset, or blank value if no matching file asset was found..
duration The value for the duration metadata field for the matching asset, or blank value if no matching file asset was found.
encodeFormat The value for the encode format metadata field for the matching asset, or blank value if no matching file asset was found.
encodeProfile The value for the encode profile metadata field for the matching asset, or blank value if no matching file asset was found.
fileName The value for the file name metadata field for the matching asset, or blank value if no matching file asset was found.
fileSize The value for the file size metadata field for the matching asset, or blank value if no matching file asset was found.
fileType The value for the file type metadata field for the matching asset, or blank value if no matching file asset was found.
fileUri The value for the file URI metadata field for the matching asset, or blank value if no matching file asset was found.
height The value for the height metadata field for the matching asset, or blank value if no matching file asset was found.
lookupKey The value for the lookup key metadata field for the matching asset, or blank value if no matching file asset was found.
materialId The value for the material ID metadata field for the matching asset, or blank value if no matching file asset was found.
mimeType The value for the mime type metadata field for the matching asset, or blank value if no matching file asset was found.
resolution The value for the resolution metadata field for the matching asset, or blank value if no matching file asset was found.
width The value for the width metadata field for the matching asset, or blank value if no matching file asset was found.

Executes a saved content search on the Title repository and writes the search results to the specified file, and upload the file to the same path on content server node if there is existent content server node.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
searchId No The ID of the saved content search to execute.
resultsFilename No The path to the file that the search results are written to.
RESPONSE MESSAGE:
Parameter Name Description / Value
success The result of the operation. Expected value: true.

Gets the metadata / properties for a file asset registered for an asset in the specified title. The title may have been previously deleted.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The ID of the title containing the file asset for which to get the properties.
fileId No The ID of the file asset for which to get the properties.
RESPONSE MESSAGE:
Parameter Name Description / Value
aspectratio The value for the aspect ratio metadata field for the file asset.
bitrate The value for the bit rate metadata field for the file asset.
checksum The value for the checksum metadata field for the file asset.
duration The value for the duration metadata field for the file asset.
encodeFormat The value for the encode format metadata field for the file asset.
encodeProfile The value for the encode profile metadata field for the file asset.
fileName The value for the file name metadata field for the file asset.
fileSize The value for the file size metadata field for the file asset.
fileType The value for the file type metadata field for the file asset. Possible values:
  • ORIGINAL
  • HISTORICAL
  • DERIVED
fileUri The value for the file URI metadata field for the file asset.
height The value for the height metadata field for the file asset.
lookupKey The value for the lookup key metadata field for the file asset.
materialId The value for the material ID metadata field for the file asset.
mimeType The value for the mime type metadata field for the file asset.
resolution The value for the resolution metadata field for the file asset.
width The value for the width metadata field for the file asset.

Gets the list of IDs for all title lists that exist in the application.

REQUEST MESSAGE:
There are no request message parameters.
RESPONSE MESSAGE:
Parameter Name Description / Value
titleListIds A comma separated list of the IDs of all title lists in the application (in ascending order).
titleListIdList A list of the IDs of all title lists in the application (in ascending order).

Gets the values for upto 8 different properties of a title list.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleListId No The ID of the title list for which to get the title list properties.
name1 No The name of the first title list property to read.
name2
name3
name4
name5
name6
name7
name8
Yes The name of the title list property to read. A blank value indicates that the corresponding title list property value does not need to be read.
RESPONSE MESSAGE:
Parameter Name Description / Value
value1
value2
value3
value4
value5
value6
value7
value8
The value for the corresponding title list property. If the corresponding title list property name does not exist or is blank, a blank value is returned.

Gets the count of all the active master tiles given the provider ID and filtered by the start date and end date (optional).

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
providerId No The provider ID
startDate No

Only active master titles that are created within the specified date interval will be included in the count. The start date (inclusive) is the beginning date of this interval. Format for this value is "yyyy-MM-dd".

Sample value: 2011-07-21

endDate Yes

The end date (inclusive) of the date interval used to search for the titles. Format for this value is "yyyy-MM-dd". If the end date is not specified, the API will return the count of all active master titles created on and after the start date for the given provider ID.

Sample value: 2011-10-21

RESPONSE MESSAGE:
Parameter Name Description / Value
count The count of all active master titles that match the provider ID and date interval.

Gets the total run time of all the active master titles given the provider ID and filtered by the start date and end date (optional). The run time value is obtained from the "Fields/Duration/Duration" field in the TITLE asset for the title.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
providerId No The provider ID
startDate No

Only active master titles that are created within the specified date interval will be included in the total run time. The start date (inclusive) is the beginning date of this interval. Format for this value is "yyyy-MM-dd".

Sample value: 2011-07-21

endDate Yes

The end date(inclusive) of the date interval used to search for the titles. Format for this value is "yyyy-MM-dd". If end date is not specified, the API will return the total run time for all active master titles created on and after the start date for the given provider ID.

Sample value: 2011-10-21

RESPONSE MESSAGE:
Parameter Name Description / Value
totalDurationInSeconds The total run time in seconds from all active master titles that match the provider ID and date interval.

Performs a search on the series repository for the IDs of Series that match the specified search criteria. The search criteria is made of up to 5 different metadata fields with an 'AND' condition applied to the applicable criteria.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
field1Xpath No The name or alias of the metadata field to match as the first search criteria condition.
field1AssetType No

The complete path of asset types to the asset to match as the first search criteria condition. The complete path uses the '/' character as a separator.

For example, to search for a metadata field in 'SERIES', the complete path value would be: SERIES.

field1Value No The value to match for the metadata field as the first search criteria condition.
field2Xpath
field3Xpath
field4Xpath
field5Xpath
Yes The name or alias of the metadata field to match as a search criteria condition. A blank value indicates that this condition should not be included in the search criteria.
field2AssetType
field3AssetType
field4AssetType
field5AssetType
Yes

The complete path of asset types to the asset to match as the a search criteria condition. The complete path uses the '/' character as a separator. If the corresponding fieldXpath parameter value is blank, this value is ignored and not added as a search criteria condition. This value should NOT be blank if the corresponding fieldXpath parameter value is not blank.

field2Value
field3Value
field4Value
field5Value
Yes The value to match for the metadata field as a search criteria condition. If the corresponding fieldXpath parameter value is blank, this value is ignored and not added as a search criteria condition. This value should NOT be blank if the corresponding fieldXpath parameter value is not blank.
RESPONSE MESSAGE:
Parameter Name Description / Value
seriesIds A comma separated list of the IDs of series records that match the search criteria.
matchingSeriesCount The number of series records that match the search criteria.

Creates an association between the title asset found based on the provided titleId with provided seriesId and seasonId.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The Id of title asset that is going to be modified by attaching supploed series Id and season Id to it.
seriesId No

The Id of series that needs to be associated with the title.

seasonId yes The Id of season that needs to be associated with the title. The season Id is related to the series that is represented by supplied series Id.
RESPONSE MESSAGE:
Parameter Name Description / Value
There is no data/information sent out to the caller except a ACK and NACK response.

Performs a search on the series repository for the IDs of Season that match the specified search criteria. The search is restricted to the repository of series found based on supplied series Ids. The search criteria is made of up to 5 different metadata fields with an 'AND' condition applied to the applicable criteria.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
seriesIds No A comma separated list of series Ids that the search is restricted to.
field1Xpath No The name or alias of the metadata field to match as the first search criteria condition.
field1AssetType No

The complete path of asset types to the asset to match as the first search criteria condition. The complete path uses the '/' character as a separator.

For example, to search for a metadata field in 'SEASON', the complete path value would be: SERIES/SEASON.

field1Value No The value to match for the metadata field as the first search criteria condition.
field2Xpath
field3Xpath
field4Xpath
field5Xpath
Yes The name or alias of the metadata field to match as a search criteria condition. A blank value indicates that this condition should not be included in the search criteria.
field2AssetType
field3AssetType
field4AssetType
field5AssetType
Yes

The complete path of asset types to the asset to match as the a search criteria condition. The complete path uses the '/' character as a separator. If the corresponding fieldXpath parameter value is blank, this value is ignored and not added as a search criteria condition. This value should NOT be blank if the corresponding fieldXpath parameter value is not blank.

field2Value
field3Value
field4Value
field5Value
Yes The value to match for the metadata field as a search criteria condition. If the corresponding fieldXpath parameter value is blank, this value is ignored and not added as a search criteria condition. This value should NOT be blank if the corresponding fieldXpath parameter value is not blank.
RESPONSE MESSAGE:
Parameter Name Description / Value
matchingSeriesIds A comma separated list of the IDs of series records that match the search criteria.
matchingSeasonIds A comma separated list of the IDs of season records corresponding to the series record that match the search criteria. Please note that the elements in seriesIds list and seasonIds list are matched by index for co-relation.
matchingSeasonCount The number of season records that match the search criteria.

Adds a new asset for title asset found based on the provided titleId. The type of asset created is determined by the provided assetType and it will be created under the parent asset provided by parentAssetId. Contentclass will be applied.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId No The Id of title that is going to be modified by adding a new asset.
assetType No

The asset type of the title asset that is to be added, e.g "MOVIE"

Please see section A. of the appendix for asset type values. PACKAGE,SERIES, and FILE asset type are not supported

parentAssetId yes The Id of the parent asset for the new asset. A blank value means the newly added asset will be added to root asset(PACKAGE or SERIES).
RESPONSE MESSAGE:
Parameter Name Description / Value
assetId The asset ID of the newly added asset.

Gets the title ID given the Document ID or root asset ID.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
documentId No The document ID or the ID of the root asset.
RESPONSE MESSAGE:
Parameter Name Description / Value
titleId The title ID.

Gets the assetId of the first asset that matches the asset type and metadata values given the title ID, asset ID and the metadata xpaths. 'File' type is not supported.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId NO The ID of the title to get assetId and metadata values.
assetType NO

The type of the asset that contains the metadata field to read.

Sample values: PACKAGE, MOVIE, POSTER

field1
field2
field3
field4
field5
field6
field7
field8
field9
field10
YES The name of the metadata fields to read.
RESPONSE MESSAGE:
Parameter Name Description / Value
assetId The assetId of the first asset that matches the asset type.
value1
value2
value3
value4
value5
value6
value7
value8
value9
value10
The metadata values for matching asset fields.

Set list of title property values with matching list of property names. Setting the value to "NULL" will cause the property to be deleted.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId NO The ID of the title for which to set the property value.
propertyNames YES The list of the property names for which to set the values.
propertyValues YES The list of the values to set for the property names. A "NULL" value will delete the property.
RESPONSE MESSAGE:
There are no response message parameters.

Advanced title search with the ability to supply logical operators.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
field1Xpath No The name or alias of the metadata field to match as the first search criteria condition.
field1AssetType No

The complete path of asset types to the asset to match as the first search criteria condition. The complete path uses the '/' character as a separator.

For example, to search for a metadata field in the 'MOVIE' asset under the 'PACKAGE' asset, the complete path value would be: PACKAGE/MOVIE

Please check section A. of the appendix for all supported asset type values.

field1Value No The value to match for the metadata field and the operator as the first search criteria condition.

For operators like ISEMPTY or ISNOTEMPTY (where the value is not provided when used in UI) any value can be provided.
field1Operator No Following logical operators are supported for this message.
EQUAL
LESSTHAN
GREATERTHAN
LESSTHANEQUAL
GREATERTHANEQUAL
ISEMPTY
ISNOTEMPTY
NOTEQUAL
CONTAINS
DOESNOTCONTAIN
STARTSWITH
ENDSWITH
DOESNOTSTARTWITH
DOESNOTENDWITH
GREATERTHANTODAY
LESSTHANTODAY
EQUALTOTODAY
NOTEQUALTOTODAY
CONTAINSUNPARSABLE
NOTGREATERTHANTODAY
NOTLESSTHANTODAY
DOESNOTCONTAINUNPARSABLE
MISSINGCONTENT
NOTMISSINGCONTENT
field2Xpath
field3Xpath
field4Xpath
field5Xpath
Yes The name or alias of the metadata field to match as a search criteria condition. A blank value indicates that this condition should not be included in the search criteria.
field2AssetType
field3AssetType
field4AssetType
field5AssetType
Yes

The complete path of asset types to the asset to match as the a search criteria condition. The complete path uses the '/' character as a separator. If the corresponding fieldXpath parameter value is blank, this value is ignored and not added as a search criteria condition. This value should NOT be blank if the corresponding fieldXpath parameter value is not blank.

For example, to search for a metadata field in the 'MOVIE' asset under the 'PACKAGE' asset, the complete path value would be: PACKAGE/MOVIE

Please check section A. of the appendix for all supported asset type values.

field2Value
field3Value
field4Value
field5Value
Yes The value to match for the metadata field as a search criteria condition. If the corresponding fieldXpath parameter value is blank, this value is ignored and not added as a search criteria condition. This value should NOT be blank if the corresponding fieldXpath parameter value is not blank.
field2Operator
field3Operator
field4Operator
field5Operator
Yes Logical Operators. The operator should not be blank, if the corresponding fieldXpath parameter value is not blank.
RESPONSE MESSAGE:
Parameter Name Description / Value
titleIds A comma separated list of the IDs of master titles that match the search criteria.
matchingTitleCount The number of master titles that match the search criteria.

Gets the value of the status for a master title.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId NO The ID of the title
RESPONSE MESSAGE:
Parameter Name Description / Value
distributionStatus The current aggregated distribution status of the title. Possible values:
  • NONE
  • WAITING
  • IN_PROGRESS
  • DISTRIBUTED
  • FAILED

Checks if metadata has changed between 2 revisions of a title for a given Asset ID and list of Field xpaths. If version1 and version2 are not provided, the latest revision of title is compared with its previous non-draft revision of the title.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId NO The ID of the title for which the metadata change is evaluated.
assetId NO The ID of the asset in the title asset tree or the ID of registered file asset which contains the metadata values to compare
fieldXpathList NO The ECMF metadata Field Xpath List which contains the list of Field xpaths for which the metadata change is evaluated.
version1 YES Revision number of the of title.
version2 YES Revision number of the of title.
RESPONSE MESSAGE:
Parameter Name Description / Value
metadataChanged If metadata has been changed in atleast one of the fieldXpaths provided, it returns true otherwise false.
revision1 Revision number of the title.
revision2 Revision number of the title.

Get the multiple values for a metadata field given the title ID, the asset ID and the fieldXpath to find the field. If no such field exists, returns an empty string array. If multiple values exist for the field, return a string array.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
titleId NO The title id (required)
assetId NO The asset id (required)
fieldXpath NO The field xpath (required)
RESPONSE MESSAGE:
Parameter Name Description / Value
values a string array

The following are the list of values supported for title asset types (in alphabetical order):

  • AUDIO
  • BARKER
  • BOXCOVER
  • DISPLAY
  • ENCRYPTED
  • FILE (This is a special value used for file assets and is not supported for all operations)
  • GAME
  • LOGICALCLIP
  • MOVIE
  • MOVIESEGMENTGROUP
  • PACKAGE
  • POSTER
  • PREVIEW
  • PREVIEWSEGMENTGROUP
  • TITLE
  • TRICK
  • SERIES
  • SEASON
© 2002 - 2010 Ericsson Television Inc.
All Rights Reserved.